home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / programs / ubbs208b.zip / UBBSFMTS.TXT < prev    next >
Text File  |  1991-07-25  |  39KB  |  972 lines
  1.                          UltraBBS v2.08 File Formats
  2.                                   07/25/91
  3.  
  4. Message File Format
  5. -------------------
  6.  
  7. In the messages file (extension ".DAT"), each record is 150 bytes long. The 
  8. first record in each messages file has the following format:
  9.  
  10. struct firstrecord
  11. {
  12.  long nextrecord;
  13.  long highmsgnum;
  14.  long lowmsgnum;
  15.  long lastfidomsgimported;
  16.  char reserved[134];
  17. }
  18.  
  19. The nextrecord variable contains the next record # that should be used in 
  20. the messages file (first record in file is record # 0).  The highmsgnum 
  21. variable contains the current high message number in the message base, and 
  22. lowmsgnum contains the current low message number in the message base.
  23. The lastfidomsgimported variable is used by the FIDOCVT program and
  24. is the number of the last message that was imported by FIDOCVT (or the
  25. last message that has already been exported to FIDO format).
  26.  
  27. The header of each message in the messages file has the following format:
  28.  
  29. struct msgrecord
  30. {
  31.  long msgnum;
  32.  unsigned char from[26];
  33.  unsigned char to[26];
  34.  unsigned char msgdate[9];
  35.  unsigned char msgtime[6];
  36.  unsigned char subject[26];
  37.  unsigned char msgpass[21];
  38.  unsigned char active;
  39.  long referto;
  40.  unsigned char datercvd[9];
  41.  unsigned char records;
  42.  unsigned char private;
  43.  unsigned char timercvd[6];
  44.  unsigned char echoflag;
  45.  unsigned char rr;
  46.  unsigned char perm;
  47.  unsigned char attached;
  48.  int hasreplies;
  49.  unsigned char reserved[4];
  50. }
  51.  
  52. All character arrays ("strings") are NULL TERMINATED character arrays!  
  53. They are NOT padded with spaces!  This applies for the rest of this file, 
  54. except where specifically stated otherwise.  Whatever follows the null byte 
  55. is of no consequence, it is ignored.
  56.  
  57. The msgnum variable is the number of this message.  The from variable
  58. is the name of the user who entered the message.  The to variable is
  59. the name of the user to whom the message was entered.  The msgdate variable
  60. is the date on which the message was entered ("MM/DD/YY" format).  The
  61. msgtime variable is the time on which the message was entered ("HH:MM"
  62. format).  The subject variable is the subject of the message.  The msgpass
  63. variable is the password of the message, it should be null if there is no
  64. password on the message.  The active variable is nonzero if the message is
  65. active, zero if the message is killed.  The referto variable contains the
  66. message number of the message which this message is a reply off of, 0
  67. if this message is not a reply to any other message.  The datercvd variable
  68. contains the date on which this message was received ("MM/DD/YY" format),
  69. it should be a 0 length string if the message has not been received yet.  
  70. The records variable contains the # of records in the message's text area 
  71. (it does NOT include the header!).  The private variable is nonzero if the 
  72. message is receiver only, or zero if it is public or password protected.  
  73. The timercvd variable contains the time on which this message was received 
  74. ("HH:MM" format), it should be a 0 length string if the message has not been
  75. received yet.  The echoflag variable is used only for conferences designated
  76. as 'echo' conferences.  If nonzero, it is assumed that the message is
  77. supposed to be exported for echomail, if zero, it should stay only in the
  78. local message base.  The rr variable is nonzero if the user has requested a
  79. return receipt, zero if he has not (a return receipt is generated when the 
  80. message is first received, the rr flag is NOT changed).  The perm variable 
  81. is nonzero if the message cannot be killed by the receiver, zero if it can 
  82. (this should only be used on public messages).  The attached variable is 
  83. nonzero if a file is attached to the message, zero if a file is not 
  84. attached.  The hasreplies variable is nonzero if the message has replies
  85. to it, otherwise it is set to zero.  The reserved variable is used for
  86. future use and should be set to all nulls. If a file is attached, it will
  87. be placed in a subdirectory off of your attach directory named
  88. MSGNUMBER.CONF (for example, ATTACHDIR\1.0\filename.ext for message # 1 in
  89. conference # 0).
  90.  
  91. The actual text records of the message (following each header) are strings
  92. of text, each representing a line of the message, followed by (Ctrl-A)
  93. characters.  The very last (Ctrl-A) of the message (representing the
  94. (Enter) on the last line of the message) is followed by a (Ctrl-B)
  95. character.  The rest of the current record is padded out by unpredictable
  96. characters to the next 150-byte boundary.
  97.  
  98. The records in the messages index file (extension ".NDX") have the 
  99. following format:
  100.  
  101. struct messageindexrecord
  102. {
  103.  long record;
  104.  unsigned char to[26];
  105.  unsigned char from[26];
  106.  unsigned char private;
  107.  unsigned char active;
  108.  unsigned char subject[26];
  109. }
  110.  
  111. The index begins at the low message number specified in the first record of 
  112. the message file.  The long integer is the record # in the messages file of 
  113. the message it represents (first record in file is record # 0 again). For 
  114. example, if the low message number is 5, and you wanted to find message # 5 
  115. in the messages file, you would look at the first record in the index file 
  116. to get message # 5's record in the messages file.  The to, from, private, 
  117. active, and subject fields should correspond to those fields in that 
  118. message's actual header.  Since the index file is based on the lowmsgnum 
  119. variable, you will not want to change the lowmsgnum variable at any time 
  120. unless your program does a complete pack of the message files.
  121.  
  122. FileBase File Format
  123. --------------------
  124.  
  125. In the FileBase data file (extension ".DAT"), each record is 338 bytes 
  126. long.  Each file entry in the file has the following format:
  127.  
  128. struct filerecord
  129. { 
  130.  unsigned char file[13];
  131.  unsigned long filesize;
  132.  unsigned char uploadedby[26];
  133.  int timesdled;
  134.  unsigned char filelocation[41];
  135.  unsigned char lastdl[9];
  136.  unsigned char dateoful[9];
  137.  int freefile;
  138.  unsigned char id[5];
  139.  unsigned char descrip[225];
  140.  int deleteflag;
  141. }
  142.  
  143. The file variable contains the actual file name of the file on the BBS.  
  144. The filesize variable contains the size (in bytes) of the file on disk, or
  145. 0 if the file has a "variable" size.  The uploadedby field contains the full
  146. name of the user who uploaded the file.  The timesdled field contains the
  147. number of times that this file has been downloaded.  The filelocation
  148. variable contains the actual physical location of the file (on the disk
  149. drive).  The lastdl and dateoful fields contain (in "MM/DD/YY" format) the
  150. last date the file was downloaded, and the date that the file was uploaded,
  151. respectively.  The freefile variable is nonzero if the file is free (no
  152. download charge), or zero if not.  The idvariable contains the 4 character
  153. Directory ID of the file.  The descrip variable contains the description of
  154. the file (5 lines, 45 characters each).  The descrip variable is NOT null
  155. terminated and is padded with spaces!  The deleteflag variable is nonzero
  156. if the file is flagged for deletion, zero if not.
  157.  
  158. The FileBase index files have a one-character extension that is the first 
  159. letter in their file name.  The records in the FileBase index files have 
  160. the following format:
  161.  
  162. struct fileindexrecord
  163. {
  164.  unsigned char file[13];
  165.  unsigned char id[5];
  166.  long record;
  167.  long binarydate;
  168. }
  169.  
  170. The file variable contains the file name of the file.  The id variable 
  171. contains the 4 character Directory ID of the file.  The record variable 
  172. contains the actual record (again, first record in data file is # 0) in the 
  173. FileBase data file where complete information on the file is stored.  The 
  174. binarydate field contains the file's date as a long integer.  This value is 
  175. obtained by rearranging the fields of the date to YYMMDD and then taking
  176. the value into a long integer (ie: 10/12/90 = 901012).
  177.  
  178. User File Format
  179. ----------------
  180.  
  181. In the Users data file (extension ".DAT"), each record is 1695 bytes 
  182. long.  Each user entry in the file has the following format:
  183.  
  184. struct userrecord
  185. {
  186.  unsigned char name[26];
  187.  unsigned char userpass[21];
  188.  int security;
  189.  int expert;
  190.  unsigned char city[21];
  191.  unsigned char lastdate[9];
  192.  unsigned char lasttime[6];
  193.  unsigned char newfchk[9];
  194.  int downloads;
  195.  int uploads;
  196.  int elapsedmins;
  197.  unsigned char page;
  198.  unsigned char voice[14];
  199.  unsigned char data[14];
  200.  unsigned char protocol;
  201.  int timeson;
  202.  unsigned int doorsent;
  203.  unsigned int msgsent;
  204.  unsigned char confs[25];
  205.  long lastmsg[200];
  206.  unsigned char expiredate[9];
  207.  int expiresec;
  208.  unsigned char econfs[25];
  209.  unsigned char birthdate[9];
  210.  unsigned char sysopcomment[61];
  211.  unsigned char fileforuser[41];
  212.  unsigned char autopage;
  213.  unsigned char userscanconfs[25];
  214.  int deleteuser;
  215.  unsigned char reserved2;
  216.  double kuploaded;
  217.  double kdownloaded;
  218.  unsigned char fsdefault;
  219.  int clrscrn;
  220.  int timestored;
  221.  long kbytesdled;
  222.  unsigned char reserved[6];
  223. }
  224.  
  225. The name variable is the full name of the user.  The userpass variable 
  226. contains the user's password.  The security variable contains the user's 
  227. security level.  The expert variable is nonzero if the user has turned on 
  228. expert mode, zero if not.  The city variable contains the user's 
  229. city/state.  The lastdate and lasttime variables (in "MM/DD/YY" and "HH:MM" 
  230. form, respectively) contain the last date and last time on which the user 
  231. called the BBS.  The newfchk variable (in "MM/DD/YY" format) contains the 
  232. last date that the user checked for new files.  The downloads and uploads 
  233. variables contain the number of downloads and uploads the user has done on 
  234. the BBS.  The elapsedmins field contains the elapsed minutes that the user 
  235. has spent on the BBS in all his calls on the last date he called.  The page 
  236. variable contains the user's screen page length.  The voice and data 
  237. variable contains the user's voice and data phone numbers, respectively.  
  238. The protocol variable contains the user's default transfer protocol.  The 
  239. timeson, doorsent, and msgsent variables contain the number of times the 
  240. user has logged on, the number of doors he has opened, and the number of 
  241. messages he has entered, respectively.  The confs variable is a 25-byte
  242. (NOT null terminated) field that consists of 200 bits, each representing
  243. one conference in the user's conference string (for example, bit 0 of the
  244. first byte is conference 0, bit 2 of the second byte is conference 10).
  245. The lastmsg[] array is a 200-element array of long integers, representing the
  246. last message number read in each conference (0-199).  The expiredate (in 
  247. "MM/DD/YY" format) contains the date on which the user's subscription will 
  248. expire ("00/00/00" means it won't expire).  The expiresec variable contains 
  249. the security level to set this user to after his subscription expires.  The 
  250. econfs variable is the same format as the confs variable described above, 
  251. but is the conference string to set the user to after his subscription 
  252. expires.  The birthdate variable contains the date (in "MM/DD/YY" format) 
  253. on which the user was born.  The sysopcomment variable contains the comment 
  254. which the sysop has put on this user.  The fileforuser variable contains 
  255. the name of a file to display to the user upon login (a 0 length string if 
  256. no file should be displayed).  The autopage character should be set to 
  257. 'N', 'I', or 'V'.  An 'N' means that no autopage will be done when this 
  258. user logs on.  If it is set to 'I' or 'V', an invisible or visible 
  259. (respectively) autopage will be executed when the user logs in.  The 
  260. userscanconfs variable works the same way as the two conference variables 
  261. mentioned above.  It defined the conferences that will be scanned upon 
  262. login, with the (Y) command, with (R A), for offline reading, etc.  The 
  263. deleteuser variable, if set to a nonzero value, means the user is marked 
  264. for deletion, otherwise the user is not marked for deletion.  The reserved2 
  265. variable is reserved for future use and should be left alone.  The 
  266. kuploaded and kdownloaded variables (stored as double precision values in 
  267. IEEE format) store the number of kilobytes (bytes / 1024) that the user has 
  268. uploaded and downloaded, respectively.  The fsdefault variable should be 
  269. set to a value of 0, 1, or 2.  A 0 means to ask the user if he wishes to 
  270. use the full screen editor each time he enters a message.  A 1 means that 
  271. the user wishes to use the full screen editor whenever possible, and a 2 
  272. means to not use it whenever possible.  The clrscrn variable, if set to a 
  273. nonzero value, means that the user wishes the screen to be clear prior to 
  274. reading each message; otherwise, the screen is not cleared.  The timestored 
  275. variable stored the amount of time (in minutes) that the user has stored in 
  276. the time bank.  The kbytesdled variable stores the number of kilobytes that
  277. the user had downloaded on his last date on.  The reserved variable is
  278. reserved for future use and must be set to all nulls.
  279.  
  280. The User File index files have a one-character extension that is the first 
  281. letter in the full name of the user.  The records in the user index files 
  282. have the following format:
  283.  
  284. struct userindexrecord
  285. {
  286.  unsigned char username[26];
  287.  long record;
  288. }
  289.  
  290. The username field is the full name of the user, and the record field is 
  291. the record (again, record # 0 is the first record in the data file) in the 
  292. users data file of this user.
  293.  
  294. Conferences Data File Format
  295. ----------------------------
  296.  
  297. In the conferences data file, each record is 2717 bytes long.  The first 
  298. record in the file contains the information for Conference # 0, the second 
  299. record contains the information for Conference # 1, and so on.  The format 
  300. of each record is as follows:
  301.  
  302. struct confrecord
  303. {
  304.  unsigned char confname[41];
  305.  int allowalias;
  306.  int echoconf;
  307.  int allowesc;
  308.  int maxdir;
  309.  unsigned char msgsfile[41];
  310.  unsigned char mainmenufile[41];
  311.  unsigned char sysopmenufile[41];
  312.  unsigned char newsfile[41];
  313.  unsigned char uploaddir[31];
  314.  int defaultfiledir;
  315.  unsigned char doormenu[41];
  316.  unsigned char doorlst[41];
  317.  unsigned char bltmenu[41];
  318.  unsigned char bltlst[41];
  319.  unsigned char quesmenu[41];
  320.  unsigned char queslst[41];
  321.  unsigned char dirmenu[41];
  322.  unsigned char votingmenu[41];
  323.  unsigned char votinglst[41];
  324.  int allowupload;
  325.  struct dirinfo
  326.  {char dirid[5];
  327.   int dirsec;
  328.  } dir[300];
  329. }
  330.  
  331. The confname variable is the name of this conference.  The allowalias 
  332. variable, if set to nonzero means that aliases will be allowed in this 
  333. conference, else aliases will not be allowed.  If echoconf is nonzero, then 
  334. this conference is designated as 'echo', and users entering messages will 
  335. be prompted as to whether they wish to make their messages 'echo' or not.  
  336. If allowesc if nonzero, then users are allowed to use ESC (usually ANSI) 
  337. codes in their messages.  The maxdir variable contains the highest 
  338. directory number in this conference.  The msgsfile variable contains the 
  339. name (without extension) of the message file for this conference.  The 
  340. mainmenufile, sysopmenufile, newsfile, and uploaddir variables contain the 
  341. names for the main menu file, the sysop menu file, the news file, and the 
  342. directory to place uploads, respectively.  The defaultfiledir variable 
  343. stores the default file directory number to place uploaded files in.  The 
  344. doormenu, doorlst, bltmenu, bltlst, quesmenu, queslst, dirmenu, votingmenu, 
  345. and votinglst variables contain the file names of the door menu, door data 
  346. file, bulletins menu, bulletins data file, questionnaire menu, 
  347. questionnaire data file, file directory menu, voting booths menu, and 
  348. voting booths data file.  If the allowupload variable is zero, then uploads 
  349. will not be allowed in this conference.  The dir[] array is an array of 300 
  350. structures, each containing a 4 character directory ID and the security 
  351. required to download files from that directory ID.  All elements of dir[] 
  352. above the maxdir number are ignored.  
  353.  
  354. NODEINFO File Format
  355. --------------------
  356.  
  357. The NODEINFO file contains 99 records, each corresponding to a node on the 
  358. system.  Any records above your highest node number are ignored, but should 
  359. still be there.  The format of each node's record is as follows (71 byte
  360. record length):
  361.  
  362. struct noderecord
  363. {
  364.  unsigned char status;
  365.  unsigned char groupsummons;
  366.  unsigned char nodepage;
  367.  unsigned char nodebeeps;
  368.  unsigned char lasteventdate[9];
  369.  unsigned char lasteventtime[6];
  370.  unsigned char nodeuser[26];
  371.  unsigned char logoffflag;
  372.  unsigned char nodedoor[21];
  373.  int exittodos;
  374.  int lasteventnumber;
  375.  int pagingsysop;
  376. }
  377.  
  378. The status variable contains the status of this node.  Possible values are 
  379. as follows:
  380.    0 = UltraBBS isn't loaded on this node
  381.    1 - 99 = User is in a private (1-99) channel in node chat
  382.    100 = User is available for chat
  383.    101 = User is unavailable for chat
  384.    102 = User is entering a message
  385.    103 = User is in a door
  386.    104 = User is in remote DOS
  387.    105 = User is transferring a file
  388.    108 = User is in main channel of node chat
  389.    109 = This node is waiting for calls
  390.    110 = User is chatting with sysop
  391.    111 = User is logging onto BBS (not at main menu yet)
  392. The groupsummons variable is nonzero if this node is being summoned to 
  393. group chat.  After displaying the summons to the user, this flag is set to 
  394. zero.  The nodepage and nodebeeps variables record the state of the page 
  395. bell and beeps on this node (nonzero = on, zero = off).  The lasteventdate 
  396. and lasteventtime variables (in "MM/DD/YY" and "HH:MM" formats) store the 
  397. date and time of the last event run on this node.  The nodeuser variable 
  398. stores the user name of the user on this node.  The logoffflag variable, if 
  399. set to 1, it means that the user on this node has a logoff pending.  If it 
  400. is set to 2, it means that the user on this node has a lockout pending.  
  401. The nodedoor variable stores the name of the door that the user on this 
  402. node is in, if he is in a door.  The exittodos variable, if nonzero, means 
  403. that this node should exit to DOS after the current caller, or if no caller 
  404. is online, it should exit to DOS immediately.  The lasteventnumber 
  405. variable stores the number of the last event that was executed.  The
  406. pagingsysop variable is nonzero if the user is currently paging the sysop,
  407. zero if he is not.
  408.  
  409. Callers File Format
  410. -------------------
  411.  
  412. The callers file for each node is created by taking the name specified in 
  413. the SETUP program, and appending the current node number (for example, if 
  414. Node 1's callers log would be CALLER1, then Node 99's callers log would be 
  415. CALLER99).  Each entry in the callers log is exactly 79 bytes long.  The 
  416. last two bytes are a CR/LF sequence (ASC 13, ASC 10).  The file, when 
  417. TYPEd, appears to be a text file, but must NOT be modified as a text file!
  418.  
  419. Doors Data File Format
  420. ----------------------
  421.  
  422. The first record in the doors data file is door # 1, the second record is 
  423. door # 2, etc.  The format of each record is as follows (98 byte record 
  424. length):
  425.  
  426. struct doorrecord
  427. {
  428.  unsigned char doorname[21];
  429.  unsigned char doorfile[41];
  430.  int doorsec;
  431.  unsigned char doorpass[21];
  432.  unsigned char doortype[11];
  433.  int doorwatch;
  434. }
  435.  
  436. The doorname variable contains the name of this door.  The doorfile 
  437. variable contains the full path (and any parameters) to the .BAT file for 
  438. this door. The doorsec variable contains the security level required to 
  439. access this door.  The doorpass variable contains the password required to 
  440. access this door (a 0 length string if no password is required).  The 
  441. doortype variable contains the door type which will be used for the CONVERT 
  442. program.  The doorwatch variable, if nonzero, means that the FOSSIL will 
  443. reboot the computer if the user hangs up in this door.
  444.  
  445. Questionnaires Data File Format
  446. -------------------------------
  447.  
  448. The first record in the questionnaires data file is questionnaire # 1, the 
  449. second is questionnaire # 2, etc.  The format of each record is as follows 
  450. (126 byte record length):
  451.  
  452. struct quesrecord
  453. {
  454.  unsigned char quesname[21];
  455.  unsigned char quesfile[41];
  456.  unsigned char ansfile[41];
  457.  int quessec;
  458.  unsigned char quespass[21];
  459. }
  460.  
  461. The quesname variable is the name of this questionnaire.  The quesfile and 
  462. ansfile variables are the file names of the questionnaire script file, and 
  463. the output answers file, respectively.  The quessec variable is the 
  464. security required to answer this questionnaire, and the quespass variable 
  465. is the password that is required (a 0 length string means no passworD).
  466.  
  467. Voting Booths Data File Format
  468. ------------------------------
  469.  
  470. The first record in the voting booths data file is voting booth # 1, the 
  471. second is voting booth # 2, etc.  The format of each record is as follows 
  472. (1388 byte record length):
  473.  
  474. struct votingrecord
  475. {
  476.  unsigned char votingname[46];
  477.  unsigned char datafile[41];
  478.  int votingsec;
  479.  unsigned char votingpass[21];
  480.  unsigned char choices[18][71];
  481. }
  482.  
  483. The votingname variable is the question presented by this voting booth.  
  484. The datafile variable contains the name of the voting results data file for 
  485. this voting booth.  The votingsec & votingpass variables contain the 
  486. security required for this voting booth, and the password required for the 
  487. booth (0 length password means no password).  The choices[] array is an 18 
  488. element array containing strings of the 18 possible responses.
  489.  
  490. Bulletins Data File Format
  491. --------------------------
  492.  
  493. The first record in the bulletins data file is bulletin # 1, the second 
  494. record is bulletin # 2, etc.  The format of each record is as follows (64 
  495. byte record length):
  496.  
  497. struct bltrecord
  498. {
  499.  unsigned char bltfile[41];
  500.  unsigned char bltpass[21];
  501.  int bltsec;
  502. }
  503.  
  504. The bltfile variable contains the file name of the actual bulletin.  The 
  505. bltpass & bltsec variables contain the password (0 length means no 
  506. password) and the security required to access this bulletin.
  507.  
  508. No Uploads File Format
  509. ----------------------
  510.  
  511. The format of a record in the no uploads file is as follows (43 byte record 
  512. length):
  513.  
  514. struct nouprecord
  515. {
  516.  unsigned char file[41];
  517.  int upsecurity;
  518. }
  519.  
  520. The file variable is the wildcard specification for this entry.  The 
  521. upsecurity variable contains the minimum security level required to upload 
  522. a file that matches the wildcard spec.
  523.  
  524. Compression Methods Data File Format
  525. ------------------------------------
  526.  
  527. The first record in the compression methods data file will be the default 
  528. compression method for use in Qmail packets.  The format for each entry is 
  529. as follows (224 byte record length):
  530.  
  531. struct comprecord
  532. {
  533.  unsigned char ext[4];
  534.  unsigned char viewform[51];
  535.  unsigned char addform[51];
  536.  unsigned char getform[51];
  537.  unsigned char testform[51];
  538.  unsigned char badtext[16];
  539. }
  540.  
  541. The ext variable contains the 3 character extension used by this 
  542. compression method.  The viewform, addform, getform, and testform store the 
  543. command line needed to execute the various functions.  See the UltraBBS 
  544. sysop documentation for more information on what these strings should look 
  545. like.  The badtext variable contains the text that the compressor will 
  546. display if a file is bad during an integrity check.
  547.  
  548. Protocols Data File Format
  549. --------------------------
  550.  
  551. The format of each record in the protocols data file is as follows (109 
  552. byte record length):
  553.  
  554. struct protrecord
  555. {
  556.  unsigned char letter;
  557.  unsigned char batch;
  558.  unsigned char uload[41];
  559.  unsigned char dload[41];
  560.  unsigned char protname[21];
  561.  int atsign;
  562.  int dszlog;
  563. }
  564.  
  565. The letter variable is the letter used to select this protocol from the 
  566. BBS.  The batch variable should be set to 'S', 'M', or 'B' for single file, 
  567. multiple files, or bidirectional multiple files.  The uload and dload 
  568. variables store the name of the batch file for uploads and downloads, 
  569. respectively (dload variable is used for bidirectional transfer batch 
  570. files).  The protname variable contains the name of this protocol.  The 
  571. atsign variable, if nonzero, means that this protocol supports the 
  572. '@listfile' command line parameter, to transfer up to 99 files instead of 
  573. just 6 or 7.  The dszlog variable, if nonzero, means that this protocol 
  574. will write a DSZ.LOG file after a download.
  575.  
  576. Limits Data File Format
  577. -----------------------
  578.  
  579. The format of each record in the limits data file is as follows (14 byte
  580. record length):
  581.  
  582. struct limitsrecord
  583. {
  584.  int limitssec;
  585.  int limitsmins;
  586.  int kbytesperup;
  587.  int filesperup;
  588.  int doornumber;
  589.  long kbytesperday;
  590. }
  591.  
  592. The limitssec variable is the security for which this record applies.  The 
  593. limitsmins variable is the number of minutes that this security level will 
  594. get each day.  The kbytesperup (stored as a double precision IEEE format 
  595. number) and filesperup variables determine how many Download Kilobytes the 
  596. user may have for each 1 Upload Kilobyte; and the number of Download Files 
  597. the user may have for each 1 Upload File.  To negate the function of 
  598. either, set it to 0.  The doornumber variable contains the door number 
  599. which will be automatically opened when any user of this security level 
  600. logs on.  The kbytesperday variable stores the number of kilobytes that
  601. a user of this security level can download per day.
  602.  
  603. Voting Results Data File Format
  604. -------------------------------
  605.  
  606. A voting results data file contains records 27 bytes in length for each 
  607. user who has voted (a user will not appear more than once in the file).  
  608. The format of each record is as follows:
  609.  
  610. struct votedrecord
  611. {
  612.  unsigned char name[26];
  613.  unsigned char choice;
  614. }
  615.  
  616. The name variable is the name of the user to which this vote applies, and 
  617. the choice variable is the choice number which he voted for.
  618.  
  619. Node Chat Data File Format
  620. --------------------------
  621.  
  622. Each record (one character typed in node chat) is 3 bytes in the node chat 
  623. data file.  The first byte of the record is a char that should be set to 
  624. the channel # that this message is going through (0-99).  If the record is 
  625. representing a character, then the second byte of the record should be set 
  626. to the number of the node that is sending the character, and the third byte 
  627. should be set to the actual character.  If the record is to notify of an 
  628. exit/entrance/hangup/etc, then the second byte should be set to 253 for a 
  629. force off (hang up, etc), 254 for an entrance, and 255 for an exit; and the 
  630. third byte should be set to the node number to which this 
  631. exit/entrance/hangup applies to.
  632.  
  633. UBBS.SYS Door Exit File Format
  634. ------------------------------
  635.  
  636. The UBBS.SYS file is created before exiting to a door, and is read back in 
  637. by UltraBBS upon returning to obtain info about who is on.  This file is 
  638. usually just used by CONVERT to make other, more commonly used, door files, 
  639. but some software authors may wish to use it to alter user information, or 
  640. obtain more detailed, UltraBBS-specific information.  Its format is as 
  641. follows:
  642.  
  643. struct ubbs_sysfile
  644. {
  645.  long modembaud;
  646.  long callerbaud;
  647.  int eight_bit;
  648.  char time_on[6];
  649.  char date_on[9];
  650.  int kbytesperup;
  651.  int filesperup;
  652.  long kbytesperday;
  653.  int graphics;
  654.  long userpos;
  655.  int local_user;
  656.  int confnum;
  657.  char confsjoined[200];
  658.  char prevdate[9];
  659.  char prevtime[6];
  660.  int disable_remote;
  661.  int available;
  662.  long logon_time;
  663.  long secs_session;
  664.  long elapsedsecs;
  665.  long eventadjust;
  666.  char markedfiles[99][13];
  667.  unsigned char markednum;
  668.  char oldfchk[9];
  669.   -------------------- Variables below this line are write-only.  UltraBBS
  670.                        does not read them in upon returning from a door.
  671.                        If you wish to modify other variables, do so in the
  672.                        users file!               
  673.  char bbsname[31];
  674.  char sysopname[26];
  675.  char curtime[6];
  676.  char page_bell;
  677.  char beeps;
  678.  int junk;
  679.  long timeused;
  680.  char eventtime[6];
  681.  int eventactive;
  682.  int port;
  683.  char usermixed[26];
  684.  int minsremaining;
  685.  char node;
  686.  struct user currentuser;
  687. }
  688.  
  689. The modembaud variable contains the actual bps rate (locked bps rate) of 
  690. the port.  The callerbaud variable contains the bps rate the caller is 
  691. actually communicating at.  eight_bit is nonzero if the caller is 8N1, zero 
  692. if 7E1.  The time_on string contains the time at which the caller logged on 
  693. (HH:MM format), and date_on contains the date at which he logged on 
  694. (MM/DD/YY format).  kbytesperup and filesperup contain the number of 
  695. kilobytes that this user may download per kilobyte he uploads, and files he 
  696. may down per file he uploads (a value of 0 sets these to unlimited).  The 
  697. graphics variable is 0 if (N)o graphics, 1 if (B)lack & White graphics, 2 
  698. if (C)olor graphics.  The userpos variable contains the user's position in 
  699. the user file (the first record in user file is rec # 0).  local_user is 
  700. nonzero if the user is on local, zero if remote.  confnum contains the 
  701. current conference number the user is in.  confsjoined is a non-null 
  702. terminated string that contains spaces or 'X's, specifying which 
  703. conferences the user has joined during the current call.  The prevdate and 
  704. prevtime variables (MM/DD/YY and HH:MM) contain the date and time of the 
  705. user's last call (before this one).  disable_remote if nonzero if the 
  706. remote user's keyboard is disabled, zero otherwise.  available is nonzero 
  707. if the user is available for chat, zero otherwise.  logon_time contains the 
  708. seconds at which the user logged in (# of seconds elapsed since 00:00:00 
  709. Greenwich mean time, January 1, 1970).  secs_session contains the number of 
  710. seconds this user has per call (obtained from LIMITS.DAT).  elapsedsecs is 
  711. the number of seconds this user has used in calls earlier today.  
  712. eventadjust is the number of seconds the user has lost today because of 
  713. time adjustments due to upcoming events.  markedfiles is an array of 
  714. strings (containing 99 strings) containing which files the user has marked 
  715. to download via the (FL) command.  markednum contains the number of files 
  716. the user has marked.  oldfchk contains the last date (MM/DD/YY format) 
  717. which the user checked for new files.  bbsname contains the name of the 
  718. BBS.  sysopname is the name of the sysop, in all caps.  The curtime 
  719. variable contains the time (HH:MM format) that this UBBS.SYS file was 
  720. created.  The page_bell variable is true (nonzero) if the page bell is on, 
  721. zero if it's off.  beeps is nonzero if beeps/music is on, zero otherwise.  
  722. The junk variable is not used.  timeused contains the amount of time (in 
  723. seconds) the user has used so far today.  eventtime contains the time 
  724. (HH:MM format) of the next event.  eventactive is nonzero if any events are 
  725. configured, zero otherwise.  port contains the COM port number of the 
  726. current COM port (0=COM1, 1=COM2, 2=COM3, etc).  usermixed contains the 
  727. mixed case name of the user (ie: 'Bob Farmer').  minsremaining contains the 
  728. time, in minutes, that the user has remaining as of the creation of this 
  729. UBBS.SYS file.  This variable can be used, possibly in conjunction with the 
  730. curtime variable, to quickly obtain a time left calculation.  The node 
  731. variable contains the node # of this node.  The currentuser structure is in 
  732. the same format as a record in the user file (see above), and contains the 
  733. user record of the current user.
  734.  
  735. Caller Number Data File Format
  736. ------------------------------
  737.  
  738. The caller number data file is 4 bytes, and simply contains a single
  739. long integer which is the number of calls made to the system.
  740.  
  741. UltraBBS's UBBS.DAT File Format
  742. -------------------------------
  743.  
  744. The UBBS.DAT file is a line-by-line, sequential text file maintained by the
  745. SETUP program.  The lines, in order, are as follows:
  746.  
  747. Maximum # of Messages for (O) and (D C)
  748. Event # 1 Guard Time
  749. Event # 2 Guard Time
  750. Event # 3 Guard Time
  751. Security to Edit His Own Messages
  752. Use BIOS Output?
  753. Security for (6)
  754. BBS Listing Data File Name
  755. Security for (BB)
  756. Use Terse Caller Logging?
  757. Caller Number File Name
  758. Number of Rings to Skip Before Answering
  759. Instant Logon Password
  760. Event # 2 Active?
  761. Event # 3 Active?
  762. Event # 2 Time
  763. Event # 3 Time
  764. Security for (11)
  765. Security for (TI)
  766. Maximum Storable Time in (TI)
  767. Check Message 'To' Field?
  768. Delete the File For User?
  769. Birthday File Name
  770. Security for (10)
  771. Start of SysOp Page Hours
  772. End of SysOp Page Hours
  773. Holding Directory Name
  774. Scratch Directory Name
  775. No New Users File Name
  776. FileBase File Name
  777. Help Prefix File Name
  778. Conference Data File Name
  779. Conference Menu File Name
  780. Caller File Prefix File Name
  781. Node Chat File Name
  782. Welcome File Name
  783. Goodbye File Name
  784. Limits Data File Name
  785. NODEINFO Data File Name
  786. Protocols Data File Name
  787. User Data File Name
  788. No Registration File Name
  789. No Uploads Data File Name
  790. Low Security File Name
  791. New User File Name
  792. Remote DOS Batch File Name
  793. Aliases Data File Name
  794. User Security Files Path Name
  795. Event # 1 Time
  796. BBS Name
  797. SysOp's Name
  798. Initialization Command
  799. Answer Command
  800. Off-Hook Command
  801. Batch Directory Name
  802. Public Conferences String (exactly 200 chars)
  803. New User Questionnaire File
  804. New User Answers File
  805. Expired Subscription File Name
  806. Compression Data File Name
  807. Post-Upload Batch File Name
  808. Node Number
  809. Communications Port
  810. Allow New Users?
  811. Security to Overwrite Files
  812. RTS/CTS Checking?
  813. Test Uploads?
  814. Security for (M)ultiple Copy Save
  815. Security to Read Killed Messages
  816. Security to Edit/Move Messages
  817. Security to Kill Any Messages
  818. Security to Skip Message Password
  819. Security to Leave Message To SysOp
  820. Initialization Baud Rate
  821. Page Bell FIle Name
  822. Private Directory ID
  823. Security for (G X)
  824. Highest Node Number
  825. Minimum Security to Logon
  826. Security to Classify Files
  827. Use Post-Upload Batch File?
  828. New User Security
  829. Allow Aborting of Welcome?
  830. Lowest Baud Rate Allowed
  831. Seconds Allowed for Registration
  832. Security to Read Private Messages
  833. Seconds Between Node Checks
  834. SysOp Menu Security
  835. Upload Time Credit Factor
  836. Seconds of Idle Time Allowed
  837. Security to Edit Any Description
  838. Security to Import File into Message
  839. Lock Baud Rate?
  840. Allow 7E1 Callers?
  841. Event # 1 Active?
  842. Shell to Doors?
  843. Reboot on DOS Hangup?
  844. Shell to DOS?
  845. Security for (NO)/(CH)
  846. Security for (B)
  847. Security for (W)
  848. Security for (OP)/(DO)
  849. Security for (G)
  850. Security for (I)
  851. Security for (J)
  852. Security for (K)
  853. Security for (O)
  854. Security for (P)
  855. Security for (Q)
  856. Security for (R)
  857. Security for (S)
  858. Security for (US)
  859. Security for (V)
  860. Security for (X)
  861. Security for (Y)
  862. Security for (1)
  863. Security for (2)
  864. Security for (3)
  865. Security for (4)
  866. Security for (5)
  867. Security for (7)
  868. Security for (8)
  869. Security for (BI)
  870. Security for (D)
  871. Security for (ED)
  872. Security for (U)
  873. Security for (Z)
  874. Security for (VI)
  875. Security for (RE)
  876. Security for (F)
  877. Security for (N)
  878. Security for (E)
  879. Security to Page Unavailable Users
  880. Security for (WH)
  881. Security for (L)
  882. Security to Request Return Receipt
  883. Security to Forward a Message
  884. Pre-Upload File Name
  885. Qmail Offline ID
  886. BBS City/State
  887. BBS Phone Number
  888. Qmail Menu File Name
  889. Security for (FL)
  890. File Attach Directory Name
  891. Allow Non-2-Word Names?
  892. Continue After Modem Init Failure?
  893. Security for (9)
  894.  
  895. Information for BASIC Programmers
  896. ---------------------------------
  897.  
  898. All numbers are stored in IEEE format.  Variable information:
  899.  
  900. An 'unsigned char' or a 'char' is a numerical value stored in one byte.  To 
  901. convert it to BASIC, read it in as a 1-character string (A$, for example), 
  902. then, to get its value into a variable, (A%, for example), use A% = ASC(A$).
  903.  
  904. An 'int' or an 'unsigned int' is a 2-byte number, equivalent to BASIC's 
  905. INTEGER type (%).
  906.  
  907. A 'long' or an 'unsigned long' is a 4-byte integral number, equivalent to 
  908. QuickBASIC's LONG INTEGER type (&).
  909.  
  910. A 'double' is an 8-byte floating point number, equivalent to BASIC's DOUBLE 
  911. type (#).  NOTE: older versions of Microsoft's QuickBASIC store DOUBLEs in 
  912. Microsoft Binary format, remember, these are in IEEE format - 4.0+ of 
  913. QuickBASIC is fine.
  914.  
  915. A 'float' is a 4-byte floating point number, equivalent to BASIC's SINGLE 
  916. type (!).  NOTE: older versions of Microsoft's QuickBASIC store SINGLEs in 
  917. Microsoft Binary format, remember, these are in IEEE format - 4.0+ of 
  918. QuickBASIC is fine.
  919.  
  920. Any numerical type with a number in brackets after the variable name is an 
  921. array of the number of elements specified in brackets.  Two pairs of 
  922. brackets means a two-dimensional array, etc.
  923.  
  924. An 'unsigned char ....[]' value (unless it is literally an array of char 
  925. values) is a string.  The value in brackets is the max length of the 
  926. string.  However, all strings are null terminated.  First, this means that 
  927. the 'max length of the string' in brackets will actually be one more than 
  928. the true max length.  Second, at the end of all meaningful characters
  929. in the string, there will be a null (ASCII 0) character, followed by 
  930. unpredictable trash.  The strings are NOT padded with spaces!  When reading 
  931. in these "string" values, use a BASIC STRING of the length in the brackets, 
  932. and this command may be used afterwards to obtain a true BASIC string:
  933. REAL.STRING$ = LEFT$(STRING.FROM.FILE$, INSTR(STRING.FROM.FILE$, CHR$(0))-1)
  934. Some arrays of unsigned char are not actually strings, but as mentioned 
  935. earlier, literally arrays of char values, and when this is the case, it is 
  936. mentioned in the description of that structure in this document.
  937.  
  938. Information for Pascal Programmers
  939. ----------------------------------
  940.  
  941. An 'unsigned char' type corresponds to Turbo Pascal's byte type.
  942.  
  943. A 'char' type corresponds to Turbo Pascal's shortint type.
  944.  
  945. An 'unsigned int' type corresponds to Turbo Pascal's word type.
  946.  
  947. An 'int' type corresponds to Turbo Pascal's integer type.
  948.  
  949. An 'unsigned long' or 'long' type corresponds to Turbo Pascal's longint type.
  950.  
  951. A 'double' is an 8-bit floating point type, and a 'float' is a 4-bit 
  952. floating point type.  Their Pascal equivalent types vary widely.  See your 
  953. compiler guide, and remember, these are in IEEE format.
  954.  
  955. Any numerical type with a number in brackets after the variable name is an 
  956. array of the number of elements specified in brackets.  Two pairs of 
  957. brackets means a two-dimensional array, etc.
  958.  
  959. An 'unsigned char ....[]' value (unless it is literally an array of char 
  960. values) is a string.  The value in brackets is the max length of the 
  961. string.  However, all strings are null terminated.  First, this means that 
  962. the 'max length of the string' in brackets will actually be one more than 
  963. the true max length.  Second, at the end of all meaningful characters
  964. in the string, there will be a null (ASCII 0) character, followed by 
  965. unpredictable trash.  The strings are NOT padded with spaces!  When reading 
  966. in these "string" values, use a packed array of char of the length in the 
  967. brackets.  The true length of the string will be the position of the first 
  968. ASCII 0 (null) minus one (assuming first char in the string is pos # 1).
  969. Some arrays of unsigned char are not actually strings, but as mentioned 
  970. earlier, literally arrays of char values, and when this is the case, it is 
  971. mentioned in the description of that structure in this document.
  972.